<HTML>
<HEAD>
<TITLE>HELP - InlineFormattedCode</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - InlineFormattedCode</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','ExampleCode0',this)" class="pathLink">Example Code</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_class','HowToDocument0',this)" class="pathLink">HowToDocument</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">InlineFormattedCode</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("","","","");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_member','InlineFormattedCode2587069908','_description',this)" class="tabLinkActive">Description</a></span>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_member','InlineFormattedCode2587069908','_source',this)" class="tabLinkInActive">Source</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Call Graph</span></span>
<script type="text/javascript">
 Body4();
</script>
<div class="contentAirTop"></div>
<span class="paragraph1">HowToDocument::InlineFormattedCode</span>
<span class="padding">( Public Method  )</span>
<div class="paddingAuthor">Author:  N.F.S Grundtvig (The members of this class inherits the author by default.) </div>
<div class="paragraph2">How to inline formatted code in the documentation.<br>
</div>
<div class="padding">&nbsp;</div>
<table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderTop" height=1>
<TR><TD height=1 width=100% class="oneLine"></TD></TR></TABLE>
<div class="paragraph2"><span id="descFunSynExpSpan" style="display:none;visibility:hidden"><a href="javascript:showElement( 'descFunSynColSpan' );javascript:hideElement( 'descFunSynExpSpan' );javascript:showElement( 'descFunSyn' );javascript:setMyCookie( cookieName, 'descFunSyn', 'show' );"><img src="../../common/expand.gif" border=0></a></span><span id="descFunSynColSpan"><a href="javascript:showElement( 'descFunSynExpSpan' );javascript:hideElement( 'descFunSynColSpan' );javascript:hideElement( 'descFunSyn' );javascript:setMyCookie( cookieName, 'descFunSyn', 'hide' );"><img src="../../common/collapse.gif" border=0></a></span>
Syntax / parameters</div>
<div id="descFunSyn" class="paddingMembersTableDiv"><table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
<TR VALIGN="top"><TD class="paddingHeadMultiColumn2"><span class="codeFont">void <a href="#" OnMouseOver="link('_member','InlineFormattedCode2587069908',this)">InlineFormattedCode</a> ()<br>
</span></TD></TR></TABLE>
<br></div>
<div class="paragraph2">Description</div>
<div id="descDesc" class="paddingMembers">How to inline formatted code in the documentation.<br>
Use: <code>\code \endcode</code>.<br>
<br>
<div class="userParagraph3">Inline formatted code in place</div>
Examples are <em>always</em> put into the "example" section, which is at the end of the generated documentation page for the entity. When using \code \endcode statements you can inline code where you want.<br>
<br>
<div class="userParagraph3">For example like this:</div>
  <table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
  <TR VALIGN="top">
  <TD class="paddingHeadMultiColumn2">
<pre class="codeExamples">
void inlinedCode()
{
  cout&lt;&lt;"This is inlined code ie. not and example!\n";
  cout&lt;&lt;"Se also!\n";
  <a href="#" onMouseOver="link('_member','ExampleInline2587069908',this); overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ExampleInline&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>How to write an example (ie not including from file).');" onMouseOut="return nd();">HowToDocument::ExampleInline</a>();
  <a href="#" onMouseOver="link('_member','ExampleInclude2587069908',this); overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ExampleInclude&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>How to include an example.');" onMouseOut="return nd();">HowToDocument::ExampleInclude</a>();
}
</pre>  </TD>
  </TR>
  </TABLE>
<br>
<br>
Then you can continue writing documentation here...<br>
<br>
<div class="userParagraph3">This is how it looks in the source:</div>
<table cellspacing=0 cellpadding=0 border=0 class="userTableBorder">
<tr>
<td class="userPaddingHeadMultiColumn2"><pre>

\code
void inlinedCode()
{
  cout&lt;&lt;"This is inlined code ie. not and example!\n";
  cout&lt;&lt;"Se also!\n";
  HowToDocument::ExampleInline();
  HowToDocument::ExampleInclude();
}
\endcode
</pre></td></tr>
</table>
</div>
<div class="paragraph2">Notes</div>
<div id="descNode" class="paddingMembers"><LI>Use <code>\pre \endpre</code> to output raw un-formatted text, or the <code>\verbatim \endverbatim</code>, which is the commands used in the original Doxygen. <br>
</div>
<div class="paragraph2">See also</div>
<div id="descSee" class="paddingMembers"><LI><a href="#" OnMouseOver="link('_member','ExampleInclude2587069908',this)">ExampleInclude()</a>, <a href="#" OnMouseOver="link('_member','ExampleInline2587069908',this)">ExampleInline()</a>.<br>
</div>
<div class="padding">&nbsp;</div>
<table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderTop" height=1>
<TR><TD height=1 width=100% class="oneLine"></TD></TR></TABLE>
<div class="paragraph2">Source</div>
<div class="paddingMembers">The documentation for this Member was generated from the following files:</div>
<div class="paddingMembers"><LI><a href="#" onMouseOver="link('_file','HowtoDocument_cpp0',this); ">HowtoDocument.cpp</a><br><LI><a href="#" onMouseOver="link('_file','HowtoDocument_h0',this); ">HowtoDocument.h</a><br></div>
<div class="contentAirBottom"></div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_member','_description');
</script>
